home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / maximus / mxaut10c.zip / MXAUTEUR.DOC < prev    next >
Text File  |  1994-07-15  |  14KB  |  273 lines
  1.   ▓▓▓▓▓▓▓▓▓▓▌▓▓▓▓▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▓▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▓▓▓▓▌▓▓▓▓▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▓▓▓▓▌
  2.   ▓▓▓▌▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌  ▓▓▓▌  ▓▓▓▌    ▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌
  3.   ▓▓▓▌▓▓▌▓▓▓▌▓▓▓▓▓▓▓▌ ▓▓▓▓▓▌ ▓▓▓▓▓▓▓▌▓▓▓▌▓▓▓▌  ▓▓▓▌  ▓▓▓▓▓▌  ▓▓▓▌▓▓▓▌▓▓▓▓▓▓▓▌
  4.   ▓▓▓▌▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌  ▓▓▓▌  ▓▓▓▌    ▓▓▓▌▓▓▓▌▓▓▓▌▓▓▌ 
  5.   ▓▓▓▌   ▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▌▓▓▓▓▓▓▓▌  ▓▓▓▌  ▓▓▓▓▓▓▓▌▓▓▓▓▓▓▓▌▓▓▓▌▓▓▓▌
  6.  
  7.      *******************************************************************
  8.      ***  This documentation was revised on July 15, 1994  so  that  ***
  9.      ***  support for the Silver Xpress offline  mail-reader  could  ***
  10.      ***  be included. Support for the Silver Xpress offline  mail-  ***
  11.      ***  reader was included due to a request by  Mr. Gary Gilmore  ***
  12.      ***  of "The Bloom County BBS" at Fido 01:2410/400.  Enjoy!     ***
  13.      *******************************************************************
  14.  
  15.      +-----------------------------------------------------------------+
  16.      |                 MaxAuteur v.010c (beta)                         |
  17.      |               by Fais Nasir @ o1:25o/718                        |
  18.      +-----------------------------------------------------------------+
  19.      |    Copyright 1994 by Independent Ick!  All Rights Reserved.     |
  20.      +-----------------------------------------------------------------+
  21.  
  22.    ┌─────────────────────┐
  23.    │ The "Disclaimer"... │  ────────────────────────────────────────────────
  24.    └─────────────────────┘
  25.  
  26.    You guys and gals know how this is supposed to go so <blah>, <blah>,
  27.    <blah> and all'a dat and don't forget it!
  28.  
  29.    Seriously though, I have tried to make MaxAuteur as `safe' as humanly
  30.    possible, but if it blows your computer up, don't blame me.  I'm not
  31.    forcing you to use this programme.  As "they all" say: This programme
  32.    is only guaranteed to take up space on your hard-drive-- nothing less,
  33.    nothing more...  I'm not saying that this programme *will* blow up;
  34.    I mean, it *shouldn't*, but stranger things have happened...
  35.  
  36.    I've had to mention a couple of other software packages in here such as
  37.    "Maximus" (without which you don't have much use for this programme
  38.    anyway), "BlueWave" and "Silver Xpress".  Please note that these pro-
  39.    grammes are the property/trademark/whatever of their respective authors
  40.    and I'm not making any sort of political statement by mentioning them
  41.    throughout this documentation.  Just rememeber that they izn't mine,
  42.    so don't be gettin' any ideas that I'm trying to make them my claim to
  43.    fame or anything like that (that's for the benefit of all of the lawyers
  44.    reading this documentation <grin>).
  45.  
  46.    ┌─────────────────────────┐
  47.    │ Welcome to "MaxAuteur"! │  ────────────────────────────────────────────
  48.    └─────────────────────────┘
  49.  
  50.    This programme is my solution to the non-existent market of message-
  51.    writer's utilties!  When I put my BBS back online in April of '93, I
  52.    had requested in various echos for someone to forward me a programme
  53.    that compiled a "Top 10" or "Best User's" listing etc. etc.  The
  54.    sysops were great and sent me various programmes which would show
  55.    you who the top callers were, the best uploaders, the most notorious
  56.    leeches etc. etc., but not one (not a one!) would make a listing of
  57.    the top message-writers.  Being the sysop of a conversations-only 
  58.    system, I was rather appalled to find that this was the case.  It 
  59.    wasn't the programmers' fault, it was Maximus-- Max doesn't keep
  60.    a track of how many messages a user writes like it does the other
  61.    statistics.  Bummer...!
  62.  
  63.    In comes "MaxAuteur".  MaxAuteur will read your Maximus logfile and
  64.    check it for messages-written by the various users on your system.
  65.    It also supports messages written by an alias, so no matter where
  66.    when or how the user writes, he or she are caught on record!
  67.  
  68.    Great, so I wrote a programme to do this, but <ack>!!!  When I 
  69.    executed the programme, I didn't see the people that I *knew*
  70.    wrote tonnes of mail!  Where were they?  The answer was obvious--
  71.    they were using the offline mail-reader!
  72.  
  73.    Here's a quick run-down of what MaxAuteur will do:
  74.  
  75.     - Reads the Maximus log for messages left via a real name *or*
  76.       an alias.
  77.  
  78.     - Reads the BlueWave log file for messages left by a user.
  79.  
  80.     - Reads the Silver Xpress log file for messages left by a user.
  81.  
  82.     - Allows the exclusion of up to five users you don't want MaxAuteur
  83.       to recognise (making you one of them is recommended).
  84.  
  85.     - Sorts the users and ranks them in a best to worst fashion.
  86.  
  87.     - Writes the acquired data to a MaxAuteur data-file (viewable).
  88.  
  89.     - Creates an .Mec file all ready for compile by Max's "MECCA" utility.
  90.  
  91.    There are two reasons you may want to use MaxAuteur.  One would be that
  92.    you simply want to keep a track of who writes how much mail (via the
  93.    "MxAuteur.Dat" file) or you want a displayable top-ten listing of those
  94.    that actually write on your board.
  95.  
  96.    ┌──────────────────────────────┐
  97.    │ Alright, the Intro's Over... │  ───────────────────────────────────────
  98.    └──────────────────────────────┘
  99.  
  100.    As you probably haven't guessed by now, this is a utility to help
  101.    you, a Maximus sysop, keep a track of the message-writer's on your
  102.    system, and of those who are not leaving any mail whatsoever
  103.    ('cause they're probably playing some game or leeching a file some-
  104.    where)...
  105.  
  106.    I am not going to go into vast details on how to use this programme
  107.    since it is relatively easy to understand <blah>, <blah> <blah>, and
  108.    after dedicating over fifteen-hundred lines of code on something like
  109.    this, writing a doc file is the least of my concerns!  I admit, I 
  110.    may have gotten a bit fancy in areas where it wasn't necessary, but
  111.    hey-- like a gun or a knife, if you `draw' your C-compiler, then you's
  112.    jes' gots t'a use it!
  113.  
  114.    ┌──────────────────────────────────────────────────────┐
  115.    │ Executing MaxAuteur & its Control File, Respectively │  ───────────────
  116.    └──────────────────────────────────────────────────────┘
  117.  
  118.    After unarchiving it into a directory of its own, you can execute it
  119.    by typing "mxauteur <filename.ctl>".  The control filename is entirely
  120.    up to you and is *not* optional.  You may use the control file that
  121.    came with this archive and edit it to reflect your own system.  Any
  122.    line beginning with a `;' (semi-colon) or a space will be ignored
  123.    by MxAuteur during runtime.
  124.  
  125.    ┌────────────────────────────────────────────────┐
  126.    │ *Required* Keywords in the MaxAuteur .Ctl File │  ─────────────────────
  127.    └────────────────────────────────────────────────┘
  128.  
  129.    Sysop <sysopname>      -  Your name, e.g. "Sysop Fais Nasir".
  130.  
  131.    System <system name>   -  Your system's name
  132.                              (e.g. "System My Kuel Doodz BBS").
  133.  
  134.    MaxAuteur [<d:><path>] -  The full path to your MaxAuteur directory
  135.                              (e.g. "MaxAuteur c:\misc\mxauteur). Trailing
  136.                              backslashes are optional.
  137.  
  138.    MaxLog [<d:><path><filename>]  -  The full path and name to your Maximus
  139.                                      log file.  Don't forget to specify the
  140.                                      the name (e.g. "MaxLog C:\Max\Max.log").
  141.  
  142.    BwLog [<d:><path><filename>]   -  The full path and name of your BlueWave
  143.                                      logfile.  If you do not use the BlueWave
  144.                                      offline mail-reader, put "None" in the
  145.                                      place of the path (e.g. "BwLog None").
  146.  
  147.    SxLog [<d:><path><filename>]   -  The full path and name of your Silver 
  148.                                      Xpress logfile.  If you do not use the
  149.                                      Silver Xpress mail-reader, put "None"
  150.                                      in the place of the path (for example,
  151.                                      "BwLog None").
  152.  
  153.    MeccaFile [<d:><path><filename>]  -  The full path and name to the MECCA
  154.                                         file you would like MaxAuteur to
  155.                                         create for you.
  156.                                         (e.g. "MeccaFile C:\Max\Top10.mec")
  157.  
  158.    ┌──────────────────────────────────────────────┐
  159.    │ Optional Keywords in the MaxAuteur .Ctl File │  ───────────────────────
  160.    └──────────────────────────────────────────────┘
  161.  
  162.    In addition to the above keywords, you may also include up to five
  163.    occurrences of the "Exclude" keyword.  You follow "Exclude" with the
  164.    name of a person on your BBS that you want MaxAuteur to ignore when
  165.    compiling the best message writer's listing.  You would probably want
  166.    to exclude yourself since otherwise you would more than likely always
  167.    be in the number one position all of the time (who writes more messages 
  168.    than the sysop???).  You may also want to exclude your 'co or assistant
  169.    sysop for the same reason.
  170.  
  171.    If you would like more information on the control file, please refer to
  172.    the file "MxAuteur.ctl" that was included in this archive.  I recommend
  173.    that you simply edit that file and use it since it would be much easier
  174.    that way.
  175.  
  176.    ┌──────────────────────────────────────────────────────────┐
  177.    │ Something that you MUST do BEFORE Running MaxAuteur...   │ ────────────
  178.    └──────────────────────────────────────────────────────────┘
  179.  
  180.    Simply put, you must set your "Log Mode" to "Verbose" in "Max.ctl".
  181.    Don't forget to "silt your Max" after doing this.  If you don't do 
  182.    this, MaxAuteur will NOT work for you.
  183.  
  184.    ┌─────────────────────────────────────────────────────────┐
  185.    │ Something that you MUST do AFTER Running MaxAuteur...   │ ─────────────
  186.    └─────────────────────────────────────────────────────────┘
  187.  
  188.    You must either rename, copy, or move your Max.log and Bw.log to a
  189.    temporary directory or file.  If you don't do this, then the next time
  190.    you run MaxAuteur, it will read the names again!  I run MaxAuteur 
  191.    every night within my maintenance routines.  After it runs, I have
  192.    the following lines in my batch file:
  193.  
  194.      c:
  195.      cd\max
  196.      rename master.log temp.log
  197.      copy temp.log + max.log master.log
  198.      delete max.log
  199.  
  200.      cd\bluewave
  201.      rename masterbw.log temp.log
  202.      copy temp.log + bw.log masterbw.log
  203.      delete bw.log
  204.  
  205.  
  206.    The above lines will append the *current* log file for Maximus and
  207.    BlueWave to the "master" file (you can decide upon the name).  Every-
  208.    thing else in the above is pretty much self-explanatory.
  209.  
  210.    Remember: If you aren't using BlueWave, be sure to set the "BwLog" 
  211.              option to "None" (minus the quotes, of course).
  212.  
  213.    If you don't understand the above lines, go buy a DOS manual...
  214.  
  215.    ┌──────────────────────────────────────────────┐
  216.    │ <Blah>, <Blah> and just a bit more'o <BLAH>! │ ────────────────────────
  217.    └──────────────────────────────────────────────┘
  218.  
  219.    This programme is about many days of non-sleeping, googly-eyed work.
  220.    As it stands, this programme will only print out the top ten on your
  221.    board, and will only give you a data file for a maximum of two-hundred
  222.    users.  It will still work if more than two-hundred people write on
  223.    your system and compile the best writers in a bulletin for you, but
  224.    it won't make a sysop report to you on those past two-hundred.
  225.  
  226.    MaxAuteur represents a lot of work on my part and I am releasing this
  227.    version into the shareware market.  If you find this programme of use,
  228.    please consider "registering" it.  Registration costs only ten bucks.
  229.    By registering, you're not going to receive a key-file or anything like
  230.    that, but then again, I could've added a nice "[UNREGISTERED]" and then
  231.    have been really bitchy and coded it so nobody would be able to alter
  232.    it.  I could've, but I didn't.  If you register, you are supporting the
  233.    shareware concept, and you should be able to sleep better at night, too!
  234.    If people don't pay me for my efforts, why the hell should I waste so
  235.    much time programming these stupid things?
  236.  
  237.    Anyway, there's the guilt-trip (in one ear, out the other, right?)...
  238.  
  239.  
  240.        Please send your registration fund to:
  241.  
  242.        Fais Nasir c/o [ATRIBBS]
  243.        52 Princess Street
  244.        Toronto, Ontario
  245.        CANADA!
  246.        M5A 4G6
  247.  
  248.    Please keep the SHAREWARE concept alive folks, and register this
  249.    piece of software!
  250.  
  251.    Even if you can't register, I would still be interested on knowing your
  252.    thoughts on MaxAuteur.  If you would like to see other features etc. etc.,
  253.    please feel free to drop me a line at the above address, or better yet,
  254.    netmail me at my Fido address (1:250/718).
  255.  
  256.    Often a programmer writes something and doesn't know how well it is 
  257.    received by the public (especially for BBS utilities).  Don't leave me
  258.    in the dark, people!  Tell me what you think!
  259.  
  260.    ┌──────────────────────────────────────────┐
  261.    │ That's It (This time around, anyway <g>! │ ────────────────────────────
  262.    └──────────────────────────────────────────┘
  263.  
  264.    Anyway, that's about it.  If you find any bugs, please let me know.  If
  265.    this dang thang' breaks, please remember, you own both halves, but I will
  266.    try to make it more "sturdy" the next time around <g>.
  267.  
  268.  
  269.    Peace out.
  270.  
  271.    Fais Nasir
  272.    [ATRIBBS]
  273.    01:250/718